Docs
This page helps you understand the objects and field mapping between Chargebee and QuickBooks.
Source Entity - Chargebee Customer
Supported Actions - Create and Update
Unsupported Actions - Delete
The following table provides information on the customer object fields mapped between Chargebee and QuickBooks:
| QuickBooks Online (QBO) Target Field | Chargebee Source Field |
Fax, Note and other |
Mapped based on the custom fields defined in the backend configuration. |
Display Name |
Based on configuration |
BillingAddrss |
billingAddress |
CompanyName |
company |
currency |
currencyCode |
PrimaryEmailAddr |
|
GivenName |
firstName |
Notes |
id |
FamilyName |
lastName |
PrimaryPhone |
phone |
PrimaryTaxIdentifier |
vatNumber / billingAddress.country Based on the configuration. Note: If useCountryForVatNumber is enabled, then vat_number_prefix is given preference else billingAddress of the country is applied. |
In QuickBooks, Item is the object name for Plans/Addons in Chargebee.
Source Entity - Chargebee Item/ Plan/ Addon
Supported Actions - Create and Update
Unsupported Actions - Delete
The following table provides information on the Line Item level mapping done between Chargebee and QuickBooks:
| QBO Target Field | Chargebee Source Field | Additional information |
Unit Price |
Computed based on price and |
Unit price is set based on the currency. |
Name |
plan.sku / plan.name addon.sku / addon.name itemPrice.sku / itemPrice.name |
sku is given preference over name. |
Sku |
itemPrice.id / plan.sku / addon.sku |
|
Description |
description | |
IncomeAccountRef |
accountcode | |
Taxable |
taxable |
Source entity - Invoice
Supported actions - Create, Update, Void, Delete
Unsupported Actions - None
The voided Invoices as Credit Notes are synced only if sync_voided_invoice_as_credit_note is enabled.
The following table provides information on the Invoice mapping done between Chargebee and QuickBooks:
| QBO Target Field | Chargebee Source Field | Additional information |
PoNumber |
poNumber/customerId |
Mapped based on the backend configuration. Note: If AdditionalConfig is enabled then we set customerId else poNumber. |
DocNumber |
id |
Mapped based on the backend configuration. |
DueDate |
dueDate |
|
TxnDate |
date | |
CurrencyRef |
currencyCode | |
ExchangeRate |
exchangeRate | Note : If base and Invoice currencies do not match then we apply the exchange rate. |
ShipAddress or Physical Address / Billing Address |
shippingAddress / Billing address | Mapping is available in the Address mapping section. |
| ApplyTaxAfterDiscount | true Note: If flag is set to True, subtract the discount first and then calculate the Sales tax. |
|
| PrivateNote | idAtGateway/referenceNumber |
Configured based on the backend configuration. Note : If the AdditionalConfig add_gw_txn_id_in_inv_memo is enabled we append the idAtGateway. If there are multiple transactions all of them are appended with the gatewayId or referenceNumber. |
| Line | LineItems |
Refer to the Item list section shown below for more details. |
| GlobalTaxCalculation | priceType |
|
| TxnTaxDetail | Mapped based on the tax mapping and tax line item details. | |
| Custom field | ||
| Definition Id | Mapped based on the backend configuration. | Note :If use_customer_id_as_po AdditionalConfig is enabled. Set the value defined as part of custom_field_id_for_po |
| Name | Mapped based on the backend configuration. | Note : If use_customer_id_as_po AdditionalConfig is enabled. Set the value defined as part of custom_field_name_for_po. |
| Type | STRING_TYPE |
|
| String Value | customerId |
Chargebee passes this information derived from Invoice billing or shipping address while syncing Invoices.
| QBO Target Field | Chargebee Source Field |
| Country | country |
Email address |
billingAddress.email |
Line1 |
firstName, lastName, or company |
Line2 |
line1 |
Line3 |
line2 |
Physical Address |
|
| billEmail | billingAddress.email |
city |
city |
| countrySubDivisionCode | stateCode |
| line4 | line3 |
| line5 | email / phone |
| postal code | zip |
Source entity - Credit Note
Supported actions - Create and Update
Unsupported Actions - None
The following table provides information on Credit Note mapping between Chargebee and QuickBooks:
| QBO Target Field | Chargebee Source Field |
| DocId | id |
TxnDate |
date |
CurrencyRef |
currencyCode |
ExchangeRate |
exchangeRate |
ApplyTaxAfterDiscount |
true Note: If flag is set to True, subtract the discount first and then calculate the Sales tax. |
PrivateNote |
idAtGateway / referenceNumber |
Based on the transaction type, we will map the fields to either payment or refund within QuickBooks.
Source Entity - Chargebee Transaction
Supported Actions - Create, Update, deletion of transactions is available based on additional config allow_transaction_delete
The following table provides information on the Transaction mapping done between Chargebee and QuickBooks:
| QBO Target Field | Chargebee Source Field | Additional information |
| TxnDate | settled_at or txn Date |
If delayed_settlement_payment_methods enabled, transaction will not be synced unless settled. |
Private Note |
referenceString |
|
PaymentRefNum |
CB internal Id |
|
DepositToAccountRef |
Based on Gateway mapping defined in the configuration | |
totalAmt |
Computed based ontxnAmount and currency |
Note : Value is adjusted if it is a zero decimal currency. |
currencyRef |
currencyCode | |
PaymentMethodRef |
card/offline |
